<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfTextUser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinftext-0.4 Reference Manual">
<link rel="up" href="ch01.html" title="libinftext API reference">
<link rel="prev" href="libinftext-0.4-inf-text-buffer.html" title="inf-text-buffer">
<link rel="next" href="libinftext-0.4-inf-text-chunk.html" title="inf-text-chunk">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libinftext-0.4-inf-text-buffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinftext-0.4 Reference Manual</th>
<td><a accesskey="n" href="libinftext-0.4-inf-text-chunk.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfTextUser.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfTextUser.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfTextUser.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfTextUser.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#InfTextUser.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="InfTextUser">
<a name="InfTextUser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfTextUser.top_of_page"></a>InfTextUser</span></h2>
<p>InfTextUser</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfTextUser.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="InfTextUser.html#InfTextUser-struct" title="InfTextUser">InfTextUser</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="InfTextUser.html#inf-text-user-get-caret-position" title="inf_text_user_get_caret_position ()">inf_text_user_get_caret_position</a>    (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="InfTextUser.html#inf-text-user-get-selection-length" title="inf_text_user_get_selection_length ()">inf_text_user_get_selection_length</a>  (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfTextUser.html#inf-text-user-set-selection" title="inf_text_user_set_selection ()">inf_text_user_set_selection</a>         (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> position</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> length</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="InfTextUser.html#inf-text-user-get-hue" title="inf_text_user_get_hue ()">inf_text_user_get_hue</a>               (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfTextUser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="../libinfinity-0.4/InfUser.html">InfUser</a>
         +----<a href="../libinfinity-0.4/InfAdoptedUser.html">InfAdoptedUser</a>
               +----InfTextUser
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="InfTextUser.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="InfTextUser.html#InfTextUser--caret-position" title='The "caret-position" property'>caret-position</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  "<a class="link" href="InfTextUser.html#InfTextUser--hue" title='The "hue" property'>hue</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write / Construct
  "<a class="link" href="InfTextUser.html#InfTextUser--selection-length" title='The "selection-length" property'>selection-length</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="InfTextUser.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="InfTextUser.html#InfTextUser-selection-changed" title='The "selection-changed" signal'>selection-changed</a>"                              : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfTextUser.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfTextUser.details"></a><h2>Details</h2>
<div class="refsect2" title="InfTextUser">
<a name="InfTextUser-struct"></a><h3>InfTextUser</h3>
<pre class="programlisting">typedef struct _InfTextUser InfTextUser;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="inf_text_user_get_caret_position ()">
<a name="inf-text-user-get-caret-position"></a><h3>inf_text_user_get_caret_position ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               inf_text_user_get_caret_position    (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
<p>
Returns the position of <em class="parameter"><code>user</code></em>'s caret.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <em class="parameter"><code>user</code></em>'s caret position.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_user_get_selection_length ()">
<a name="inf-text-user-get-selection-length"></a><h3>inf_text_user_get_selection_length ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                inf_text_user_get_selection_length  (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
<p>
Returns the number of characters this user has selected, starting from
the caret position. Negative number mean selection towards the beginning
of the buffer.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <em class="parameter"><code>user</code></em>'s selection length in characters.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_user_set_selection ()">
<a name="inf-text-user-set-selection"></a><h3>inf_text_user_set_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_user_set_selection         (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> position</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> length</code></em>);</pre>
<p>
Changes <em class="parameter"><code>user</code></em>'s selection (i.e. caret position and selection length).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>The new position for the user's caret.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>The number of characters to select. Negative numbers mean
selection towards the beginning.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_user_get_hue ()">
<a name="inf-text-user-get-hue"></a><h3>inf_text_user_get_hue ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             inf_text_user_get_hue               (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
<p>
Returns the hue of the user's color as a double ranging from 0 to 1.
The other components (saturation and lightness) are not specific to the
user and may be chosen indivudually to optimize the actual visual display.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The hue of the <em class="parameter"><code>user</code></em>'s color.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="InfTextUser.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "caret-position" property'>
<a name="InfTextUser--caret-position"></a><h3>The <code class="literal">"caret-position"</code> property</h3>
<pre class="programlisting">  "caret-position"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
<p>The position of this user's caret.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "hue" property'>
<a name="InfTextUser--hue"></a><h3>The <code class="literal">"hue"</code> property</h3>
<pre class="programlisting">  "hue"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write / Construct</pre>
<p>The hue value of the user's color. saturation and lightness are set by each client individually.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "selection-length" property'>
<a name="InfTextUser--selection-length"></a><h3>The <code class="literal">"selection-length"</code> property</h3>
<pre class="programlisting">  "selection-length"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
<p>The number of characters of this user's selection.</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="InfTextUser.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "selection-changed" signal'>
<a name="InfTextUser-selection-changed"></a><h3>The <code class="literal">"selection-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *inftextuser,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>        arg1,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>         arg2,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)        : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inftextuser</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>